Fox's Git Mirrors - /page/blob.mu

Node / rns-mirrors / Reticulum-Go.git / files / docs / en / examples.md

Displaying Rendered • View raw • Download

Sample programs under T383838examples/ show how to use Reticulum-Go as a library.

They are starting points rather than production services.

Pair this page with the API reference.

┌─────────────────────────────────┬────────────────────────────────────────────────────────────────┐

│ Goal │ Start Here │

├─────────────────────────────────┼────────────────────────────────────────────────────────────────┤

│ Smallest stack bring-up │ T383838examples/minimal │

│ Announce callbacks │ T383838examples/announce │

│ Encrypted link packets │ T383838examples/link │

│ Minimal resource send │ T383838examples/resources │

│ File list and download │ T383838examples/filetransfer │

│ Prove-all echo │ T383838examples/echo │

│ Page request client │ T383838examples/page-downloader │

│ Pages and files over Reticulum │ T383838reticulum-go pageserver or T383838examples/pageserver │

│ Browser WebSocket client │ T383838examples/wasm │

│ Python talking to the daemon │ T383838examples/control-client │

│ C / FFI smoke test │ T383838bindings/c/examples/smoke │

│ C librns page fetch │ T383838bindings/c/examples/page-fetch │

│ C librns pageserver │ T383838bindings/c/examples/pageserver │

│ Odin librns smoke │ T383838bindings/odin/examples/smoke │

│ Odin librns page fetch │ T383838bindings/odin/examples/page-fetch │

│ Odin librns pageserver │ T383838bindings/odin/examples/pageserver │

│ Zig librns smoke │ T383838bindings/zig/examples/smoke │

│ Zig librns page fetch │ T383838bindings/zig/examples/page-fetch │

│ Zig librns pageserver │ T383838bindings/zig/examples/pageserver │

│ C++ librns smoke │ T383838bindings/cpp/examples/smoke │

│ C++ librns page fetch │ T383838bindings/cpp/examples/page-fetch │

│ C++ librns pageserver │ T383838bindings/cpp/examples/pageserver │

│ Rust librns smoke │ T383838bindings/rust/examples/smoke │

│ Rust librns page fetch │ T383838bindings/rust/examples/page-fetch │

│ Rust librns pageserver │ T383838bindings/rust/examples/pageserver │

│ Python librns smoke │ T383838bindings/python/examples/smoke │

│ Python librns page fetch │ T383838bindings/python/examples/page-fetch │

│ Python librns pageserver │ T383838bindings/python/examples/pageserver │

│ Lua librns smoke │ T383838bindings/lua/examples/smoke │

│ Lua librns page fetch │ T383838bindings/lua/examples/page-fetch │

│ Lua librns pageserver │ T383838bindings/lua/examples/pageserver │

│ Swift librns smoke │ T383838bindings/swift/examples/smoke │

│ Swift librns page fetch │ T383838bindings/swift/examples/page-fetch │

│ Swift librns pageserver │ T383838bindings/swift/examples/pageserver │

│ Java librns smoke │ T383838bindings/java/examples/smoke │

│ Java librns page fetch │ T383838bindings/java/examples/page-fetch │

│ Java librns pageserver │ T383838bindings/java/examples/pageserver │

│ Kotlin librns smoke │ T383838bindings/kotlin/examples/smoke │

│ Kotlin librns page fetch │ T383838bindings/kotlin/examples/page-fetch │

│ Kotlin librns pageserver │ T383838bindings/kotlin/examples/pageserver │

│ Dart librns FFI smoke │ T383838bindings/dart/examples/smoke │

│ Odin librns bindings │ T383838bindings/odin │

│ Zig librns bindings │ T383838bindings/zig │

│ C++ librns bindings │ T383838bindings/cpp │

│ Rust librns bindings │ T383838bindings/rust │

│ Python librns bindings │ T383838bindings/python │

│ Lua librns bindings │ T383838bindings/lua │

│ Swift librns bindings │ T383838bindings/swift │

│ Java librns bindings │ T383838bindings/java │

│ Kotlin librns bindings │ T383838bindings/kotlin │

│ Dart librns FFI and Control API │ T383838bindings/dart │

│ Operator CLIs │ T383838reticulum-go status | id | probe | path | cp then >filetransfer Path: |BT383838|Fdddexamples/filetransfer/|f|b Serves a directory over a link and lets a client list and download files as resources. |BT282828|Fddd |= go run . -server -serve ./test_serve -listen-port 4242 |= |f|b >>echo Path: |BT383838|Fdddexamples/echo/|f|b Destination with prove-all. Client sends a packet and waits for a proof. >>page-downloader Path: |BT383838|Fdddexamples/page-downloader/|f|b Requests |BT383838|Fddd/page/|f|b style content from a pageserver-compatible peer. >>pageserver Preferred: |BT383838|Fdddreticulum-go pageserver|f|b (built into the main binary). Sample pages and files live under |BT383838|Fdddexamples/pageserver/|f|b. Serves: • |BT383838|Fddd/page/|f|b for HTML pages • |BT383838|Fddd/file/|f|b for static files Live interoperability is tested via |BT383838|Fdddtests/interop/pageserver_live_test.go|f|b when |BT383838|FdddRUN_LIVE_INTEROP=1|f|b is set. >>wasm Path: |BT383838|Fdddexamples/wasm/|f|b Browser chat demo using |BT383838|Fdddpkg/wasm|f|b. |BT282828|Fddd |= task build-wasm |= |f|b See |_|!|[Embedding and WebAssembly|:/page/blob.mu|g=rns-mirrors|r=Reticulum-Go.git|ref=633735d797cc5f5d48cb2e22e8fd7cd743930daf|path=docs/en/embedding-and-wasm.md">CLI Utili.

Path: T383838examples/control-client/

Python T383838client.py for the localhost Control API.

T282828

enable_control_api = yes

rpc_key = <64 hex characters>

See Control API.

Path: T383838bindings/c/examples/smoke/

Minimal C program against T383838librns.so and T383838include/rns.h.

T282828

task build-librns

make -C bindings/c/examples/smoke

./bindings/c/examples/smoke/librns-smoke

See librns.

Path: T383838bindings/c/examples/page-fetch/

NomadNet / pageserver style page request over the C ABI. Opens a path, waits for an announce, establishes a link, and prints the T383838/page/... response.

T282828

task build-librns

make -C bindings/c/examples/page-fetch

./bindings/c/examples/page-fetch/librns-page-fetch \\

-c /path/to/config \\

92798ea245a0afcfa559348e42d628c6:/page/index.mu

Add a TCP or Backbone hub from directory.rns.recipes to the config.

Path: T383838bindings/odin/examples/page-fetch/

Same flow as the C page-fetch example, using the Odin wrappers in T383838bindings/odin.

T282828

task build-librns

make -C bindings/odin/examples/page-fetch

./bindings/odin/examples/page-fetch/odin-page-fetch \\

-c /path/to/config \\

92798ea245a0afcfa559348e42d628c6:/page/index.mu

Path: T383838bindings/c/examples/pageserver/

NomadNet-compatible T383838nomadnetwork.node destination that serves T383838/page/index.mu over librns request handlers.

T282828

task build-librns

make -C bindings/c/examples/pageserver

./bindings/c/examples/pageserver/librns-pageserver \\

-c /path/to/config

Prints T383838DEST_HASH=... on startup. Fetch with the C, Odin, Zig, or C++ page-fetch example.

Run helpers (Go is the default demo pageserver):

T282828

task example:pageserver

make -C examples/pageserver run

task example:pageserver:c

task example:pageserver:odin

task example:pageserver:zig

task example:pageserver:cpp

Path: T383838bindings/odin/examples/pageserver/

Same pageserver flow using the Odin bindings.

T282828

task build-librns

make -C bindings/odin/examples/pageserver

./bindings/odin/examples/pageserver/odin-pageserver \\

-c /path/to/config

Path: T383838bindings/zig/examples/page-fetch/

Same flow as the C page-fetch example, using the Zig wrappers in T383838bindings/zig.

T282828

task build-librns

make -C bindings/zig/examples/page-fetch

./bindings/zig/examples/page-fetch/zig-page-fetch \\

-c /path/to/config \\

92798ea245a0afcfa559348e42d628c6:/page/index.mu

Path: T383838bindings/zig/examples/pageserver/

Same pageserver flow using the Zig bindings.

T282828

task build-librns

make -C bindings/zig/examples/pageserver

./bindings/zig/examples/pageserver/zig-pageserver \\

-c /path/to/config

Path: T383838bindings/cpp/examples/smoke/

Minimal C++17 lifecycle check against T383838librns.so via T383838bindings/cpp.

T282828

task build-librns

make -C bindings/cpp/examples/smoke

./bindings/cpp/examples/smoke/cpp-smoke

Path: T383838bindings/cpp/examples/page-fetch/

Same flow as the C page-fetch example, using the C++ wrappers in T383838bindings/cpp.

T282828

task build-librns

make -C bindings/cpp/examples/page-fetch

./bindings/cpp/examples/page-fetch/cpp-page-fetch \\

-c /path/to/config \\

92798ea245a0afcfa559348e42d628c6:/page/index.mu

Path: T383838bindings/cpp/examples/pageserver/

Same pageserver flow using the C++ bindings.

T282828

task build-librns

make -C bindings/cpp/examples/pageserver

./bindings/cpp/examples/pageserver/cpp-pageserver \\

-c /path/to/config

Each language binding keeps demos under T383838bindings/<lang>/examples/.

T282828

task build-librns

make -C bindings/rust examples

make -C bindings/python examples

make -C bindings/lua examples

make -C bindings/swift examples

make -C bindings/java examples

make -C bindings/kotlin examples

make -C bindings/dart examples

Smoke programs print T383838*-smoke ok. Page-fetch and pageserver match the C demos for Rust, Python, Lua, Swift, Java, and Kotlin. Dart ships FFI smoke under T383838bindings/dart/examples/smoke (Control API sample remains under T383838bindings/dart/example/).

Path: T383838bindings/odin/

Idiomatic Odin package over T383838librns.so. Requires Odin on T383838PATH and a built shared library.

T282828

task build-librns

task test-odin

Import with a collection rooted at T383838bindings/odin:

T282828

import rns "rns:rns"

Wrapped surface includes node lifecycle, identity, destination, path table, link send and request, and event poll. See librns.

Path: T383838bindings/zig/

Idiomatic Zig package over T383838librns.so. Requires Zig 0.16.0 or later on T383838PATH and a built shared library.

T282828

task build-librns

task test-zig

Import as T383838@import("rns") from a T383838build.zig dependency on T383838bindings/zig. See librns.

Path: T383838bindings/cpp/

Idiomatic C++17 RAII package over T383838librns.so. Requires CMake and a C++17 compiler, plus a built shared library.

T282828

task build-librns

task test-cpp

T282828

#include <rns/rns.hpp>

auto node_r = rns::Node::create("");

auto node = std::move(node_r).value();

node.start();

Wrapped surface matches the Odin and Zig bindings. See librns.

Path: T383838bindings/dart/

Package rns_control includes librns FFI (T383838ffi.dart) and a Control API client.

T282828

task build-librns

task test-dart

task build-librns-targets -- linux android windows

T282828

dependencies:

rns_control:

path: /path/to/Reticulum-Go/bindings/dart

See librns Dart FFI and Control API.

Most examples keep their own T383838go.mod with a replace pointing at the repository root. T383838examples/wasm and T383838examples/pageserver also vendor dependencies.

• API Reference

• Getting Started

• Links, channels, and resources

• Embedding and WebAssembly

• Control API

• librns

• CLI Utilities